本产品(
Web 应用防火墙/2021-10-01
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
实例信息
API | 标题 | API概述 |
---|---|---|
CreatePostpaidInstance | 创建Web应用防火墙3.0(按量付费)实例 | 创建Web应用防火墙3.0(按量付费)实例。 |
DescribeInstance | 获取WAF实例详情 | 获取当前阿里云账号下WAF实例的详情。 |
接入配置
API | 标题 | API概述 |
---|---|---|
云产品接入 | 云产品接入 | |
SyncProductInstance | 透明接入同步用户的ECS和CLB资产 | 同步用户的ECS和CLB资产。 |
DescribeCloudResources | 查询云产品接入WAF的实例列表 | 查询接入到WAF的云产品列表情况。 |
DescribeProductInstances | 查询已同步的云产品资产列表 | 查询已同步的云产品资产列表。 |
DescribeResourceSupportRegions | 查询云产品接入的支持区域列表 | 查询云产品接入的支持区域列表,主要指CLB,ECS产品。 |
DescribeResourceRegionId | 查询服务化接入的资源的地域ID | 查询服务化接入的资源的地域ID,主要指ALB和MSE产品。 |
DescribeResourceInstanceCerts | 查询云产品实例的证书列表 | 查询云产品实例的证书列表,该接口返回当前委派管理员和实例所属用户的证书列表,该接口仅在多账号场景下使用。 如:用户A是委派管控员,有证书cert1,云产品实例lb-xx-1是成员用户B,有证书cert2,查询实例lb-xx-1时,接口返回cert1和cert2。 |
CNAME接入 | CNAME接入 | |
DescribePunishedDomains | 查询已接入WAF域名的未备案处罚信息 | 查询已接入WAF域名的未备案处罚信息。 |
ModifyDomainPunishStatus | 重新接入未备案处罚状态的域名 | 重新接入未备案处罚状态的域名。 |
DescribeCertDetail | 查询证书详细信息 | 查询证书详细信息,如证书名称、到期时间、签发时间,绑定域名等。 |
CreateDomain | 添加CNAME接入资源 | 将域名接入WAF实例进行防护。 |
ModifyDomain | 修改CNAME接入资源 | 修改CNAME接入域名。 |
DeleteDomain | 删除CNAME接入资源 | 删除CNAME接入域名。 |
DescribeDomainDetail | 查询CNAME接入详情 | 查询域名接入详情。 |
DescribeDomains | 查询CNAME接入列表 | 查询添加到 Web 应用防火墙的域名列表。 |
DescribeCerts | 查询用户的可选证书列表 | 查询用户的证书列表。 |
DescribeWafSourceIpSegment | 获取waf实例的回源IP网段列表 | 查询WAF回源网段。 |
DescribeDomainDNSRecord | 查询CNAME域名DNS解析状态 | 查询域名DNS是否正确。 |
混合云接入 | 混合云接入 | |
DescribeHybridCloudResources | 查询混合云CNAME接入列表 | 查询混合云域名列表。 |
DescribeResourcePort | 查询实例下的所有已接入WAF端口 | 查询实例下的所有已接入WAF端口。 |
防护配置
报表信息
API | 标题 | API概述 |
---|---|---|
DescribeFlowChart | 查看流量统计信息 | 查看流量统计信息。 |
DescribePeakTrend | 查看QPS变化趋势 | 查看请求QPS的变化趋势。 |
DescribeResponseCodeTrendGraph | 查看响应码的趋势图 | 查看WAF返回给客户端、源站返回给WAF的5XX、405、499、302、444等异常响应码的数量变化趋势。 |
DescribeVisitUas | 查看流量访问Top 10的UA | 查看发起请求次数最多的前10个User-Agent。 |
DescribeVisitTopIp | 查看流量访问Top 10的IP | 查看发起请求次数最多的前10个IP。 |
DescribeRuleHitsTopResource | 查看命中防护规则的Top 10 防护对象 | 查看触发防护规则次数最多的前10个防护对象。 |
DescribeRuleHitsTopRuleId | 查看命中防护规则的Top 10规则ID | 查看触发防护规则次数最多的前10个规则ID。 |
DescribeRuleHitsTopTuleType | 查看命中防护规则的Top 10防护类型 | 查看触发防护规则次数最多的前10个防护类型。 |
DescribeRuleHitsTopUrl | 查看命中防护规则的Top 10 URL | 查看触发防护规则次数最多的前10个URL。 |
DescribeRuleHitsTopClientIp | 查看发动攻击次数Top 10的攻击源IP | 查看发动攻击次数最多的前10个攻击源IP。 |
DescribeFlowTopResource | 查看流量访问Top 10的防护对象 | 查看请求量最高的前10个防护对象。 |
DescribeRuleHitsTopUa | 查看发动攻击次数Top 10的攻击UA | 查看发动攻击次数最多的前10个User-Agent。 |
DescribeFlowTopUrl | 查看流量访问Top 10的URL | 查看发起请求次数最多的前10个URL。 |
日志配置
API | 标题 | API概述 |
---|---|---|
DescribeUserSlsLogRegions | 查询用户可用的日志存储地域 | 查询用户可用的日志存储地域。 |
DescribeUserWafLogStatus | 查询用户WAF日志服务 | 查询用户WAF日志服务的状态、RegionId,状态修改时间等。 |
DescribeSlsAuthStatus | 查询日志库授权状态 | 查询日志库授权状态。 |
DescribeSlsLogStoreStatus | 查询日志库状态 | 查询SLS日志库的状态。 |
DescribeSlsLogStore | 查询日志库信息 | 查看日志库总容量,存储时长,已使用容量等信息。 |
ModifyResourceLogStatus | 修改防护对象日志状态 | 修改防护对象日志状态。 |
DescribeResourceLogStatus | 查询防护对象日志状态 | 查询防护对象日志状态。 |
混合云集群管理
API | 标题 | API概述 |
---|---|---|
ModifyHybridCloudClusterBypassStatus | 修改混合云服务化集群手动Bypass开关 | 修改混合云服务化集群手动Bypass开关。 |
DescribeHybridCloudUser | 查询混合云客户端口 | 查询混合云接入,客户允许使用的端口范围,内容返回包括HTTP和HTTPS两类端口。 |
DescribeHybridCloudGroups | 查询混合云集群下节点组列表 | 查询添加到Web应用防火墙的混合云节点组列表。 |
多账号统一管理
API | 标题 | API概述 |
---|---|---|
CreateMemberAccounts | 添加成员账号 | 多账号统一管理功能中添加WAF成员账号。 |
ModifyMemberAccount | 修改成员账号 | 多账号统一管理中修改成员账号信息。 |
DeleteMemberAccount | 删除成员账号 | 多账号统一管理中删除WAF成员账号。 |
DescribeAccountDelegatedStatus | 查询用户是否是WAF委派管理员 | 多账号统一管理中,查询用户是否是WAF的委派管理员。 |
DescribeMemberAccounts | 查询所有成员账号 | 多账号统一管理中,查询WAF所有成员账号信息。 |
标签管理
API | 标题 | API概述 |
---|---|---|
TagResources | 为指定的资源创建并绑定标签 | 指定一个或多个资源创建并绑定标签。 |
ListTagKeys | 查询标签键 | 查询标签键。 |
UntagResources | 解绑并删除标签 | 为指定的一个或多个资源统一解绑并删除标签。 |
ListTagResources | 查询资源已经绑定的标签 | 查询资源已经绑定的标签。 |
ListTagValues | 查询指定标签键对应的标签值 | 查询指定标签键对应的标签值。 |